{
 "cells": [
  {
   "cell_type": "markdown",
   "id": "likely-radio",
   "metadata": {},
   "source": [
    "# NFT Price Floor Python API Tutorial "
   ]
  },
  {
   "cell_type": "markdown",
   "id": "d22e8023",
   "metadata": {},
   "source": [
    "This tutorial aims to be a quick guide to get you started using the NFTPriceFloor API integrated into messari's python library."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 1,
   "id": "593e4795",
   "metadata": {},
   "outputs": [],
   "source": [
    "from messari.nfts import NFTPriceFloor\n",
    "floor = NFTPriceFloor()"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 2,
   "id": "d11d83c9",
   "metadata": {},
   "outputs": [],
   "source": [
    "collections = ['boredApesYC', 'coolCats', 'cryptoPunks']"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "813f1412",
   "metadata": {},
   "source": [
    "## API Structure\n",
    "The NFT Price Floor Python client contains a number of functions that wrap some NFT Price Floor's API endpoints. These include:\n",
    "\n",
    "Functions\n",
    "\n",
    "* get_nfts\n",
    "* get_floor\n",
    "* get_info\n",
    "\n",
    "Below are a few examples to showcase the functionality and types of data each function generates."
   ]
  },
  {
   "cell_type": "markdown",
   "id": "ecd6b9b7",
   "metadata": {},
   "source": [
    "## Functions"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "a40e89fa",
   "metadata": {},
   "source": [
    "### get_nfts"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "3b1e3b3d",
   "metadata": {},
   "source": [
    "Retrieve basic info for all nfts"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 3,
   "id": "de221c03",
   "metadata": {},
   "outputs": [
    {
     "data": {
      "text/html": [
       "<div>\n",
       "<style scoped>\n",
       "    .dataframe tbody tr th:only-of-type {\n",
       "        vertical-align: middle;\n",
       "    }\n",
       "\n",
       "    .dataframe tbody tr th {\n",
       "        vertical-align: top;\n",
       "    }\n",
       "\n",
       "    .dataframe thead th {\n",
       "        text-align: right;\n",
       "    }\n",
       "</style>\n",
       "<table border=\"1\" class=\"dataframe\">\n",
       "  <thead>\n",
       "    <tr style=\"text-align: right;\">\n",
       "      <th></th>\n",
       "      <th>slug</th>\n",
       "      <th>name</th>\n",
       "      <th>floorPriceETH</th>\n",
       "      <th>floorPriceUSD</th>\n",
       "      <th>floorCapETH</th>\n",
       "      <th>floorCapUSD</th>\n",
       "      <th>totalSupply</th>\n",
       "      <th>variationETH</th>\n",
       "      <th>variationUSD</th>\n",
       "      <th>type</th>\n",
       "      <th>url</th>\n",
       "      <th>ranking</th>\n",
       "      <th>countOnSale</th>\n",
       "      <th>listedRatio</th>\n",
       "      <th>lastModification</th>\n",
       "      <th>salesData</th>\n",
       "    </tr>\n",
       "  </thead>\n",
       "  <tbody>\n",
       "    <tr>\n",
       "      <th>0</th>\n",
       "      <td>boredApesYC</td>\n",
       "      <td>Bored Ape YC</td>\n",
       "      <td>65.50</td>\n",
       "      <td>226189</td>\n",
       "      <td>655000</td>\n",
       "      <td>2261891850</td>\n",
       "      <td>10000</td>\n",
       "      <td>-5.06</td>\n",
       "      <td>-14.31</td>\n",
       "      <td>avatar</td>\n",
       "      <td>https://opensea.io/collection/boredapeyachtclu...</td>\n",
       "      <td>1</td>\n",
       "      <td>11860194301555</td>\n",
       "      <td>1.186019e+11</td>\n",
       "      <td>2022-01-06 06:15:09</td>\n",
       "      <td>{'_id': '61d686a9956dff76eb38c901', 'slug': 'b...</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>1</th>\n",
       "      <td>cryptoPunks</td>\n",
       "      <td>CryptoPunks</td>\n",
       "      <td>63.50</td>\n",
       "      <td>219283</td>\n",
       "      <td>635000</td>\n",
       "      <td>2192826450</td>\n",
       "      <td>10000</td>\n",
       "      <td>-4.08</td>\n",
       "      <td>-13.43</td>\n",
       "      <td>avatar</td>\n",
       "      <td>https://www.larvalabs.com/cryptopunks/forsale</td>\n",
       "      <td>2</td>\n",
       "      <td>1403</td>\n",
       "      <td>1.403000e+01</td>\n",
       "      <td>2022-01-06 05:45:04</td>\n",
       "      <td>{'_id': '61d686aa956dff76eb38c989', 'slug': 'c...</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>2</th>\n",
       "      <td>mutantApesYC</td>\n",
       "      <td>Mutant Ape YC</td>\n",
       "      <td>13.89</td>\n",
       "      <td>47966</td>\n",
       "      <td>245020</td>\n",
       "      <td>846118834</td>\n",
       "      <td>17640</td>\n",
       "      <td>-6.78</td>\n",
       "      <td>-15.86</td>\n",
       "      <td>avatar</td>\n",
       "      <td>https://opensea.io/collection/mutant-ape-yacht...</td>\n",
       "      <td>3</td>\n",
       "      <td>11860194302784</td>\n",
       "      <td>6.723466e+10</td>\n",
       "      <td>2022-01-06 06:14:06</td>\n",
       "      <td>{'_id': '61d686aa956dff76eb38c969', 'slug': 'm...</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>3</th>\n",
       "      <td>veeFriends</td>\n",
       "      <td>VeeFriends</td>\n",
       "      <td>11.78</td>\n",
       "      <td>40680</td>\n",
       "      <td>120804</td>\n",
       "      <td>417168484</td>\n",
       "      <td>10255</td>\n",
       "      <td>-0.08</td>\n",
       "      <td>-9.82</td>\n",
       "      <td>avatar</td>\n",
       "      <td>https://opensea.io/collection/veefriends?colle...</td>\n",
       "      <td>4</td>\n",
       "      <td>1186019430899</td>\n",
       "      <td>1.156528e+10</td>\n",
       "      <td>2022-01-06 06:13:09</td>\n",
       "      <td>{'_id': '61d686aa956dff76eb38c959', 'slug': 'v...</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>4</th>\n",
       "      <td>cloneX</td>\n",
       "      <td>CLONE X</td>\n",
       "      <td>5.30</td>\n",
       "      <td>18302</td>\n",
       "      <td>106000</td>\n",
       "      <td>366046620</td>\n",
       "      <td>20000</td>\n",
       "      <td>-18.46</td>\n",
       "      <td>-26.41</td>\n",
       "      <td>avatar</td>\n",
       "      <td>https://opensea.io/collection/clonex?collectio...</td>\n",
       "      <td>5</td>\n",
       "      <td>11860194303465</td>\n",
       "      <td>5.930097e+10</td>\n",
       "      <td>2022-01-06 06:13:36</td>\n",
       "      <td>{'_id': '61d686ab956dff76eb38c9fb', 'slug': 'c...</td>\n",
       "    </tr>\n",
       "  </tbody>\n",
       "</table>\n",
       "</div>"
      ],
      "text/plain": [
       "           slug           name  floorPriceETH  floorPriceUSD  floorCapETH  \\\n",
       "0   boredApesYC   Bored Ape YC          65.50         226189       655000   \n",
       "1   cryptoPunks    CryptoPunks          63.50         219283       635000   \n",
       "2  mutantApesYC  Mutant Ape YC          13.89          47966       245020   \n",
       "3    veeFriends     VeeFriends          11.78          40680       120804   \n",
       "4        cloneX        CLONE X           5.30          18302       106000   \n",
       "\n",
       "   floorCapUSD  totalSupply  variationETH  variationUSD    type  \\\n",
       "0   2261891850        10000         -5.06        -14.31  avatar   \n",
       "1   2192826450        10000         -4.08        -13.43  avatar   \n",
       "2    846118834        17640         -6.78        -15.86  avatar   \n",
       "3    417168484        10255         -0.08         -9.82  avatar   \n",
       "4    366046620        20000        -18.46        -26.41  avatar   \n",
       "\n",
       "                                                 url  ranking     countOnSale  \\\n",
       "0  https://opensea.io/collection/boredapeyachtclu...        1  11860194301555   \n",
       "1      https://www.larvalabs.com/cryptopunks/forsale        2            1403   \n",
       "2  https://opensea.io/collection/mutant-ape-yacht...        3  11860194302784   \n",
       "3  https://opensea.io/collection/veefriends?colle...        4   1186019430899   \n",
       "4  https://opensea.io/collection/clonex?collectio...        5  11860194303465   \n",
       "\n",
       "    listedRatio     lastModification  \\\n",
       "0  1.186019e+11  2022-01-06 06:15:09   \n",
       "1  1.403000e+01  2022-01-06 05:45:04   \n",
       "2  6.723466e+10  2022-01-06 06:14:06   \n",
       "3  1.156528e+10  2022-01-06 06:13:09   \n",
       "4  5.930097e+10  2022-01-06 06:13:36   \n",
       "\n",
       "                                           salesData  \n",
       "0  {'_id': '61d686a9956dff76eb38c901', 'slug': 'b...  \n",
       "1  {'_id': '61d686aa956dff76eb38c989', 'slug': 'c...  \n",
       "2  {'_id': '61d686aa956dff76eb38c969', 'slug': 'm...  \n",
       "3  {'_id': '61d686aa956dff76eb38c959', 'slug': 'v...  \n",
       "4  {'_id': '61d686ab956dff76eb38c9fb', 'slug': 'c...  "
      ]
     },
     "execution_count": 3,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "source": [
    "nfts = floor.get_nfts()\n",
    "nfts.head()"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "b2fc3ef5",
   "metadata": {},
   "source": [
    "### get_floor"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "a6ae73f1",
   "metadata": {},
   "source": [
    "Retrive floor data for collection(s)"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 4,
   "id": "265a2d8c",
   "metadata": {},
   "outputs": [
    {
     "data": {
      "text/html": [
       "<div>\n",
       "<style scoped>\n",
       "    .dataframe tbody tr th:only-of-type {\n",
       "        vertical-align: middle;\n",
       "    }\n",
       "\n",
       "    .dataframe tbody tr th {\n",
       "        vertical-align: top;\n",
       "    }\n",
       "\n",
       "    .dataframe thead tr th {\n",
       "        text-align: left;\n",
       "    }\n",
       "\n",
       "    .dataframe thead tr:last-of-type th {\n",
       "        text-align: right;\n",
       "    }\n",
       "</style>\n",
       "<table border=\"1\" class=\"dataframe\">\n",
       "  <thead>\n",
       "    <tr>\n",
       "      <th></th>\n",
       "      <th colspan=\"5\" halign=\"left\">boredApesYC</th>\n",
       "      <th colspan=\"5\" halign=\"left\">coolCats</th>\n",
       "      <th colspan=\"5\" halign=\"left\">cryptoPunks</th>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th></th>\n",
       "      <th>dataPriceFloorETH</th>\n",
       "      <th>dataPriceFloorUSD</th>\n",
       "      <th>dataVolumeETH</th>\n",
       "      <th>dataVolumeUSD</th>\n",
       "      <th>sales</th>\n",
       "      <th>dataPriceFloorETH</th>\n",
       "      <th>dataPriceFloorUSD</th>\n",
       "      <th>dataVolumeETH</th>\n",
       "      <th>dataVolumeUSD</th>\n",
       "      <th>sales</th>\n",
       "      <th>dataPriceFloorETH</th>\n",
       "      <th>dataPriceFloorUSD</th>\n",
       "      <th>dataVolumeETH</th>\n",
       "      <th>dataVolumeUSD</th>\n",
       "      <th>sales</th>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>dates</th>\n",
       "      <th></th>\n",
       "      <th></th>\n",
       "      <th></th>\n",
       "      <th></th>\n",
       "      <th></th>\n",
       "      <th></th>\n",
       "      <th></th>\n",
       "      <th></th>\n",
       "      <th></th>\n",
       "      <th></th>\n",
       "      <th></th>\n",
       "      <th></th>\n",
       "      <th></th>\n",
       "      <th></th>\n",
       "      <th></th>\n",
       "    </tr>\n",
       "  </thead>\n",
       "  <tbody>\n",
       "    <tr>\n",
       "      <th>2022-01-05 08:00:00</th>\n",
       "      <td>69.4050</td>\n",
       "      <td>264470.0</td>\n",
       "      <td>319.9800</td>\n",
       "      <td>1217657.0</td>\n",
       "      <td>4.0</td>\n",
       "      <td>10.6325</td>\n",
       "      <td>40516.0</td>\n",
       "      <td>134.959</td>\n",
       "      <td>513938.0</td>\n",
       "      <td>10.0</td>\n",
       "      <td>66.6225</td>\n",
       "      <td>253869.0</td>\n",
       "      <td>0.00</td>\n",
       "      <td>0.0</td>\n",
       "      <td>0.0</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>2022-01-05 16:00:00</th>\n",
       "      <td>69.5000</td>\n",
       "      <td>265250.0</td>\n",
       "      <td>472.4400</td>\n",
       "      <td>1803061.0</td>\n",
       "      <td>7.0</td>\n",
       "      <td>10.6687</td>\n",
       "      <td>40718.0</td>\n",
       "      <td>83.100</td>\n",
       "      <td>317570.0</td>\n",
       "      <td>6.0</td>\n",
       "      <td>65.4462</td>\n",
       "      <td>249785.0</td>\n",
       "      <td>64.99</td>\n",
       "      <td>246631.0</td>\n",
       "      <td>1.0</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>2022-01-06 00:00:00</th>\n",
       "      <td>68.9375</td>\n",
       "      <td>254068.0</td>\n",
       "      <td>848.3099</td>\n",
       "      <td>3064901.0</td>\n",
       "      <td>12.0</td>\n",
       "      <td>10.0225</td>\n",
       "      <td>36924.0</td>\n",
       "      <td>358.090</td>\n",
       "      <td>1317477.0</td>\n",
       "      <td>32.0</td>\n",
       "      <td>63.6225</td>\n",
       "      <td>234474.0</td>\n",
       "      <td>399.07</td>\n",
       "      <td>1423713.0</td>\n",
       "      <td>6.0</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>2022-01-06 06:15:04</th>\n",
       "      <td>65.9714</td>\n",
       "      <td>231415.0</td>\n",
       "      <td>602.5070</td>\n",
       "      <td>2102787.0</td>\n",
       "      <td>8.0</td>\n",
       "      <td>NaN</td>\n",
       "      <td>NaN</td>\n",
       "      <td>NaN</td>\n",
       "      <td>NaN</td>\n",
       "      <td>NaN</td>\n",
       "      <td>63.2857</td>\n",
       "      <td>221982.0</td>\n",
       "      <td>137.00</td>\n",
       "      <td>487296.0</td>\n",
       "      <td>2.0</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>2022-01-06 06:17:33</th>\n",
       "      <td>NaN</td>\n",
       "      <td>NaN</td>\n",
       "      <td>NaN</td>\n",
       "      <td>NaN</td>\n",
       "      <td>NaN</td>\n",
       "      <td>9.9514</td>\n",
       "      <td>34908.0</td>\n",
       "      <td>96.390</td>\n",
       "      <td>337667.0</td>\n",
       "      <td>9.0</td>\n",
       "      <td>NaN</td>\n",
       "      <td>NaN</td>\n",
       "      <td>NaN</td>\n",
       "      <td>NaN</td>\n",
       "      <td>NaN</td>\n",
       "    </tr>\n",
       "  </tbody>\n",
       "</table>\n",
       "</div>"
      ],
      "text/plain": [
       "                          boredApesYC                                  \\\n",
       "                    dataPriceFloorETH dataPriceFloorUSD dataVolumeETH   \n",
       "dates                                                                   \n",
       "2022-01-05 08:00:00           69.4050          264470.0      319.9800   \n",
       "2022-01-05 16:00:00           69.5000          265250.0      472.4400   \n",
       "2022-01-06 00:00:00           68.9375          254068.0      848.3099   \n",
       "2022-01-06 06:15:04           65.9714          231415.0      602.5070   \n",
       "2022-01-06 06:17:33               NaN               NaN           NaN   \n",
       "\n",
       "                                                 coolCats                    \\\n",
       "                    dataVolumeUSD sales dataPriceFloorETH dataPriceFloorUSD   \n",
       "dates                                                                         \n",
       "2022-01-05 08:00:00     1217657.0   4.0           10.6325           40516.0   \n",
       "2022-01-05 16:00:00     1803061.0   7.0           10.6687           40718.0   \n",
       "2022-01-06 00:00:00     3064901.0  12.0           10.0225           36924.0   \n",
       "2022-01-06 06:15:04     2102787.0   8.0               NaN               NaN   \n",
       "2022-01-06 06:17:33           NaN   NaN            9.9514           34908.0   \n",
       "\n",
       "                                                            cryptoPunks  \\\n",
       "                    dataVolumeETH dataVolumeUSD sales dataPriceFloorETH   \n",
       "dates                                                                     \n",
       "2022-01-05 08:00:00       134.959      513938.0  10.0           66.6225   \n",
       "2022-01-05 16:00:00        83.100      317570.0   6.0           65.4462   \n",
       "2022-01-06 00:00:00       358.090     1317477.0  32.0           63.6225   \n",
       "2022-01-06 06:15:04           NaN           NaN   NaN           63.2857   \n",
       "2022-01-06 06:17:33        96.390      337667.0   9.0               NaN   \n",
       "\n",
       "                                                                         \n",
       "                    dataPriceFloorUSD dataVolumeETH dataVolumeUSD sales  \n",
       "dates                                                                    \n",
       "2022-01-05 08:00:00          253869.0          0.00           0.0   0.0  \n",
       "2022-01-05 16:00:00          249785.0         64.99      246631.0   1.0  \n",
       "2022-01-06 00:00:00          234474.0        399.07     1423713.0   6.0  \n",
       "2022-01-06 06:15:04          221982.0        137.00      487296.0   2.0  \n",
       "2022-01-06 06:17:33               NaN           NaN           NaN   NaN  "
      ]
     },
     "execution_count": 4,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "source": [
    "floor_df = floor.get_floor(collections)\n",
    "floor_df.tail()"
   ]
  }
 ],
 "metadata": {
  "kernelspec": {
   "display_name": "Python 3 (ipykernel)",
   "language": "python",
   "name": "python3"
  },
  "language_info": {
   "codemirror_mode": {
    "name": "ipython",
    "version": 3
   },
   "file_extension": ".py",
   "mimetype": "text/x-python",
   "name": "python",
   "nbconvert_exporter": "python",
   "pygments_lexer": "ipython3",
   "version": "3.9.9"
  }
 },
 "nbformat": 4,
 "nbformat_minor": 5
}